/*
 * Copyright (c) 2020-2021 Heiko Bornholdt and Kevin Röbert
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 * OR OTHER DEALINGS IN THE SOFTWARE.
 */
package org.drasyl.node.identity.serialization;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.drasyl.identity.DrasylAddress;
import org.drasyl.identity.Identity;
import org.drasyl.identity.IdentityPublicKey;
import org.drasyl.identity.IdentitySecretKey;
import org.drasyl.identity.KeyAgreementPublicKey;
import org.drasyl.identity.KeyAgreementSecretKey;
import org.drasyl.identity.KeyPair;

/**
 * Provides hints for correct {@link Identity} JSON (de)serialization.
 */
@SuppressWarnings("java:S118")
public interface IdentityMixin {
    @JsonIgnore
    IdentityPublicKey getIdentityPublicKey();

    @JsonIgnore
    IdentitySecretKey getIdentitySecretKey();

    @JsonIgnore
    DrasylAddress getAddress();

    @JsonIgnore
    KeyAgreementPublicKey getKeyAgreementPublicKey();

    @JsonIgnore
    KeyAgreementSecretKey getKeyAgreementSecretKey();

    @JsonIgnore
    boolean isValid();

    @JsonCreator
    static Identity of(@JsonProperty("proofOfWork") final int proofOfWork,
                       @JsonProperty("identityKeyPair") final KeyPair<IdentityPublicKey, IdentitySecretKey> identityKeyPair,
                       @JsonProperty("keyAgreementKeyPair") final KeyPair<KeyAgreementPublicKey, KeyAgreementSecretKey> keyAgreementKeyPair) {
        return Identity.of(proofOfWork, identityKeyPair, keyAgreementKeyPair);
    }
}
